Resource URL: /platform/<<version=1>>/auth/settings/krb5/realms/<REALM>

    Overview: This resource contains krb5 authentication settings.

     Methods: GET, PUT, DELETE

********************************************************************************

Method GET: Retrieve the krb5 settings for realms.

       URL: GET /platform/<<version=1>>/auth/settings/krb5/realms/<REALM>

There are no query arguments for this method.

GET response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "additionalProperties": false, 
      "type": "object", 
      "properties": {
        "realm": {
          "minItems": 0, 
          "items": {
            "type": "object", 
            "description": "Specifies the Kerberos settings for realm access.", 
            "properties": {
              "is_default_realm": {
                "type": [
                  {
                    "type": "boolean", 
                    "description": "If true, indicates that the realm is the default."
                  }, 
                  {
                    "type": "null"
                  }
                ]
              }, 
              "realm": {
                "type": [
                  {
                    "minLength": 0, 
                    "type": "string", 
                    "description": "Specifies the name of the realm.", 
                    "maxLength": 255
                  }, 
                  {
                    "type": "null"
                  }
                ]
              }, 
              "admin_server": {
                "type": [
                  {
                    "minLength": 0, 
                    "type": "string", 
                    "description": "Specifies the administrative server hostname.", 
                    "maxLength": 255
                  }, 
                  {
                    "type": "null"
                  }
                ]
              }, 
              "kdc": {
                "type": [
                  {
                    "minItems": 0, 
                    "items": {
                      "minLength": 0, 
                      "type": "string", 
                      "maxLength": 255
                    }, 
                    "type": "array", 
                    "description": "Specifies the list of KDC hostnames.", 
                    "maxItems": 4294967295
                  }, 
                  {
                    "type": "null"
                  }
                ]
              }, 
              "default_domain": {
                "type": [
                  {
                    "minLength": 0, 
                    "type": "string", 
                    "description": "Specifies the default domain mapped to the realm.", 
                    "maxLength": 255
                  }, 
                  {
                    "type": "null"
                  }
                ]
              }, 
              "is_joined": {
                "type": [
                  {
                    "type": "boolean", 
                    "description": "If true, indicates that the realm is joined."
                  }, 
                  {
                    "type": "null"
                  }
                ]
              }, 
              "id": {
                "type": [
                  {
                    "minLength": 0, 
                    "type": "string", 
                    "description": "ID of realm", 
                    "maxLength": 255
                  }, 
                  {
                    "type": "null"
                  }
                ]
              }
            }
          }, 
          "type": "array", 
          "maxItems": 4294967295
        }
      }
    }
  ]
}

********************************************************************************

Method PUT: Modify the krb5 realm settings.

       URL: PUT /platform/<<version=1>>/auth/settings/krb5/realms/<REALM>

There are no query arguments for this method.

PUT request body schema:
{
  "type": "object", 
  "description": "Specifies the Kerberos settings for realm access.", 
  "properties": {
    "default_domain": {
      "minLength": 0, 
      "type": "string", 
      "description": "Specifies the default domain mapped to the realm.", 
      "maxLength": 255
    }, 
    "is_default_realm": {
      "type": "boolean", 
      "description": "If true, indicates that the realm is the default."
    }, 
    "admin_server": {
      "minLength": 0, 
      "type": "string", 
      "description": "Specifies the administrative server hostname.", 
      "maxLength": 255
    }, 
    "kdc": {
      "minItems": 0, 
      "items": {
        "minLength": 0, 
        "type": "string", 
        "maxLength": 255
      }, 
      "type": "array", 
      "description": "Specifies the list of KDC hostnames.", 
      "maxItems": 4294967295
    }
  }
}

There is no JSON response body for this method.

********************************************************************************

Method DELETE: Remove a realm.

          URL: DELETE /platform/<<version=1>>/auth/settings/krb5/realms/<REALM>

There are no query arguments for this method.

There is no JSON response body for this method.
